home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1998 November: Tool Chest / Dev.CD Nov 98 TC.toast / Sample Code / Snippets / Development Tools & Languages / MouseInfo / Definitions.h < prev    next >
Encoding:
Text File  |  1993-01-18  |  3.2 KB  |  122 lines  |  [TEXT/MPS ]
  1. //     Definitions.h
  2. //     Copyright ©1992 Apple Computer, Inc.
  3. //    Kent Sandvik DTS
  4. //    This file contains debugger macros
  5. //    Version Info (latest first):
  6. //
  7. //    <1>        khs        1.0        First final version
  8. //    <2>        khs        1.0.1    Fixed a memory leak in TMapApplication::GetSleepValue()
  9.  
  10.  
  11. #ifndef __DEFINITIONS__
  12. #define __DEFINITIONS__
  13.  
  14. #ifndef __TYPES__
  15. #include <Types.h>
  16. #endif
  17.  
  18.  
  19. /*     DEBUGGER FLAGS
  20.   MacApp 3.0 has many special flags which could be turned on/off from the
  21.   debug menu entry. We are mostly interested in signalling something from
  22.   the application to the source code, so we are interested to use:
  23.   gIntenseDebugging - turn on intense debugging, it will also signal to the
  24.   framework to start tracing many other things, so it's very costly.
  25.   gUserFlag1, gUserFlag2, gUserFlag3 - these are better suited for special control
  26.   that we know about. In this case we are using gUserFlag1.
  27.   WHY DON'T YOU USE MACROS, INSTEAD INLINE FUNCTIONS?
  28.   Because I'm sick-n-tired of tracing macro based problems. It should not matter,
  29.   we are still inlining code directly instead of calling functions. Also, then
  30.   I'm able to use static variables for certain 'macros' which should only do something
  31.   based on earlier state.
  32.   TMON USE
  33.   These macros are defined for MacsBug, i.e. they start with a ';' in the beginning
  34.   of the string. If you want to use TMON, change the ';' to a '™' and also change the debugger
  35.   statement to something suitable in the TMON world. BTW, these macros are based on
  36.   MacsBug 6.2.2.
  37. */
  38.  
  39. //    Globals
  40. Boolean gHeapScramble = FALSE;                    // heap scrambling
  41. Boolean gLeaks = FALSE;                            // if Leaks DCMD is installed, test for memory leaks
  42.  
  43.  
  44. inline void DBOUTPUT(CStr255 a)                    //    Call debugger with a string - used for other macros.
  45. {
  46.     if (gUserFlag1)
  47.         DebugStr(a);
  48. }
  49.  
  50.  
  51. inline void DBHEAPCHECK()                        //    Heap Check - check for heap status, it stops if something is wrong
  52. {
  53.     DBOUTPUT(";HC; G");
  54. }
  55.  
  56.  
  57. inline void DBHEAPCHECKLOG()                    //    Heap Check variation - log information inside a log file
  58. {
  59.     DBOUTPUT("Extended Heap Check:; LOG HeapTest; WH; HC; HZ; LOG; G");
  60. }
  61.  
  62.  
  63. inline void DBHEAPSCRAMBLEON()                    //    Turn on Heap Scramble
  64. {
  65.     if (!gHeapScramble)
  66.     {
  67.         DBOUTPUT("Heap Scramble ON; HS; G");
  68.         gHeapScramble = TRUE;
  69.     }
  70. }
  71.  
  72.  
  73. inline void DBHEAPSCRAMBLEOFF()                    //    Turn off Heap Scramble
  74. {
  75.     if (gHeapScramble)
  76.     {
  77.         DBOUTPUT("Heap Scramble OFF; HS; G");
  78.         gHeapScramble = FALSE;
  79.     }
  80. }
  81.  
  82.  
  83. inline void DBHEAPINFOLOG()                        //    Log Heap information into log
  84. {
  85.     DBOUTPUT("Heap Info:; LOG HeapInfo; WH; HT; HD RS; LOG; G");
  86. }
  87.  
  88.  
  89. inline void DBEVENTRECORDLOG()                    // Log Event Records at particular instances
  90. {
  91.     DBOUTPUT("Event Record:; LOG EventRecordLog; WH; DM 000234C4 EventRecord; LOG; G");
  92. }
  93.  
  94.  
  95. inline void DBLEAKSON()                            //    Turn on Leaks dcmd (assume we have it installed, if not it's on Developer CD)
  96. {
  97.     if (!gLeaks)
  98.     {
  99.         DBOUTPUT("Leaks ON; Leaks On; G");
  100.         gLeaks = TRUE;
  101.     }
  102. }
  103.  
  104.  
  105. inline void DBLEAKSOFF()                        //    Turn off Leaks dcmd
  106. {
  107.     if (gLeaks)
  108.     {
  109.         DBOUTPUT("Leaks OFF; Leaks Off; G");
  110.         gLeaks = FALSE;
  111.     }
  112. }
  113.  
  114.  
  115. //  I think you got the idea now, feel free to create any other MacsBug/low level debugger
  116. //    commands which could be used from debug mode (or actually any other Macintosh source code
  117. //    which could set a flag dynamically from the Debugger menu).
  118.  
  119.  
  120. #endif  __DEFINITIONS__
  121.  
  122.